<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>LibDriver WS2812B: ws2812b base driver function</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="doxygen.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">LibDriver WS2812B
   &#160;<span id="projectnumber">1.0.0</span>
   </div>
   <div id="projectbrief">WS2812B full function driver</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__ws2812b__base__driver.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#define-members">Macros</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">ws2812b base driver function<div class="ingroups"><a class="el" href="group__ws2812b__driver.html">ws2812b driver function</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>ws2812b base driver modules  
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structws2812b__handle__s.html">ws2812b_handle_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">ws2812b handle structure definition  <a href="structws2812b__handle__s.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structws2812b__info__s.html">ws2812b_info_s</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">ws2812b information structure definition  <a href="structws2812b__info__s.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:gae5540c5fee431b39d1a059e77d4a77e1"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ws2812b__base__driver.html#gae5540c5fee431b39d1a059e77d4a77e1">WS2812B_EACH_RESET_BIT_FRAME_LEN</a>&#160;&#160;&#160;512</td></tr>
<tr class="memdesc:gae5540c5fee431b39d1a059e77d4a77e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">ws2812b each reset bit frame length definition  <a href="group__ws2812b__base__driver.html#gae5540c5fee431b39d1a059e77d4a77e1">More...</a><br /></td></tr>
<tr class="separator:gae5540c5fee431b39d1a059e77d4a77e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:ga8e9cc95839b82bfd2baf02e566930593"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structws2812b__handle__s.html">ws2812b_handle_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a></td></tr>
<tr class="memdesc:ga8e9cc95839b82bfd2baf02e566930593"><td class="mdescLeft">&#160;</td><td class="mdescRight">ws2812b handle structure definition  <a href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">More...</a><br /></td></tr>
<tr class="separator:ga8e9cc95839b82bfd2baf02e566930593"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4d2a587a69a1cc505cb403e5bd97e4da"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structws2812b__info__s.html">ws2812b_info_s</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ws2812b__base__driver.html#ga4d2a587a69a1cc505cb403e5bd97e4da">ws2812b_info_t</a></td></tr>
<tr class="memdesc:ga4d2a587a69a1cc505cb403e5bd97e4da"><td class="mdescLeft">&#160;</td><td class="mdescRight">ws2812b information structure definition  <a href="group__ws2812b__base__driver.html#ga4d2a587a69a1cc505cb403e5bd97e4da">More...</a><br /></td></tr>
<tr class="separator:ga4d2a587a69a1cc505cb403e5bd97e4da"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga2d68712e7e7d1b8f8329217f7a153bc6"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ws2812b__base__driver.html#ga2d68712e7e7d1b8f8329217f7a153bc6">ws2812b_info</a> (<a class="el" href="group__ws2812b__base__driver.html#ga4d2a587a69a1cc505cb403e5bd97e4da">ws2812b_info_t</a> *info)</td></tr>
<tr class="memdesc:ga2d68712e7e7d1b8f8329217f7a153bc6"><td class="mdescLeft">&#160;</td><td class="mdescRight">get chip's information  <a href="group__ws2812b__base__driver.html#ga2d68712e7e7d1b8f8329217f7a153bc6">More...</a><br /></td></tr>
<tr class="separator:ga2d68712e7e7d1b8f8329217f7a153bc6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae6fbb749585737a343245f99a12541ee"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ws2812b__base__driver.html#gae6fbb749585737a343245f99a12541ee">ws2812b_init</a> (<a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *handle)</td></tr>
<tr class="memdesc:gae6fbb749585737a343245f99a12541ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">initialize the chip  <a href="group__ws2812b__base__driver.html#gae6fbb749585737a343245f99a12541ee">More...</a><br /></td></tr>
<tr class="separator:gae6fbb749585737a343245f99a12541ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6fa1311ef2353ea55c58aa3bd7033e22"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ws2812b__base__driver.html#ga6fa1311ef2353ea55c58aa3bd7033e22">ws2812b_deinit</a> (<a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *handle)</td></tr>
<tr class="memdesc:ga6fa1311ef2353ea55c58aa3bd7033e22"><td class="mdescLeft">&#160;</td><td class="mdescRight">close the chip  <a href="group__ws2812b__base__driver.html#ga6fa1311ef2353ea55c58aa3bd7033e22">More...</a><br /></td></tr>
<tr class="separator:ga6fa1311ef2353ea55c58aa3bd7033e22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga60effc5b5f3a3326ffaa3a856629d264"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ws2812b__base__driver.html#ga60effc5b5f3a3326ffaa3a856629d264">ws2812b_write</a> (<a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *handle, uint32_t *rgb, uint32_t len, uint8_t *temp, uint32_t temp_len)</td></tr>
<tr class="memdesc:ga60effc5b5f3a3326ffaa3a856629d264"><td class="mdescLeft">&#160;</td><td class="mdescRight">write reset and color frame  <a href="group__ws2812b__base__driver.html#ga60effc5b5f3a3326ffaa3a856629d264">More...</a><br /></td></tr>
<tr class="separator:ga60effc5b5f3a3326ffaa3a856629d264"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9143c3d9bf67e15e3124f06a805cb9ee"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ws2812b__base__driver.html#ga9143c3d9bf67e15e3124f06a805cb9ee">ws2812b_write_only_reset</a> (<a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *handle, uint32_t len, uint8_t *temp, uint32_t temp_len)</td></tr>
<tr class="memdesc:ga9143c3d9bf67e15e3124f06a805cb9ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">write the reset frame  <a href="group__ws2812b__base__driver.html#ga9143c3d9bf67e15e3124f06a805cb9ee">More...</a><br /></td></tr>
<tr class="separator:ga9143c3d9bf67e15e3124f06a805cb9ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac6fd3f9b02dff6d25690de921ae3e021"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ws2812b__base__driver.html#gac6fd3f9b02dff6d25690de921ae3e021">ws2812b_write_only_color</a> (<a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *handle, uint32_t *rgb, uint32_t len, uint8_t *temp, uint32_t temp_len)</td></tr>
<tr class="memdesc:gac6fd3f9b02dff6d25690de921ae3e021"><td class="mdescLeft">&#160;</td><td class="mdescRight">write the color frame  <a href="group__ws2812b__base__driver.html#gac6fd3f9b02dff6d25690de921ae3e021">More...</a><br /></td></tr>
<tr class="separator:gac6fd3f9b02dff6d25690de921ae3e021"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf9000e2cf8036d77c73d9131f8e8e495"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__ws2812b__base__driver.html#gaf9000e2cf8036d77c73d9131f8e8e495">ws2812b_set_reg</a> (<a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *handle, uint8_t *buf, uint16_t len)</td></tr>
<tr class="memdesc:gaf9000e2cf8036d77c73d9131f8e8e495"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the chip register  <a href="group__ws2812b__base__driver.html#gaf9000e2cf8036d77c73d9131f8e8e495">More...</a><br /></td></tr>
<tr class="separator:gaf9000e2cf8036d77c73d9131f8e8e495"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>ws2812b base driver modules </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="gae5540c5fee431b39d1a059e77d4a77e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae5540c5fee431b39d1a059e77d4a77e1">&#9670;&nbsp;</a></span>WS2812B_EACH_RESET_BIT_FRAME_LEN</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define WS2812B_EACH_RESET_BIT_FRAME_LEN&#160;&#160;&#160;512</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>ws2812b each reset bit frame length definition </p>
<p>512 </p>

<p class="definition">Definition at line <a class="el" href="driver__ws2812b_8h_source.html#l00063">63</a> of file <a class="el" href="driver__ws2812b_8h_source.html">driver_ws2812b.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga8e9cc95839b82bfd2baf02e566930593"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8e9cc95839b82bfd2baf02e566930593">&#9670;&nbsp;</a></span>ws2812b_handle_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structws2812b__handle__s.html">ws2812b_handle_s</a> <a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>ws2812b handle structure definition </p>

</div>
</div>
<a id="ga4d2a587a69a1cc505cb403e5bd97e4da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4d2a587a69a1cc505cb403e5bd97e4da">&#9670;&nbsp;</a></span>ws2812b_info_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structws2812b__info__s.html">ws2812b_info_s</a> <a class="el" href="group__ws2812b__base__driver.html#ga4d2a587a69a1cc505cb403e5bd97e4da">ws2812b_info_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>ws2812b information structure definition </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga6fa1311ef2353ea55c58aa3bd7033e22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga6fa1311ef2353ea55c58aa3bd7033e22">&#9670;&nbsp;</a></span>ws2812b_deinit()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ws2812b_deinit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *&#160;</td>
          <td class="paramname"><em>handle</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>close the chip </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 spi deinit failed</li>
<li>2 handle is NULL</li>
<li>3 handle is not initialized </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ws2812b_8c_source.html#l00387">387</a> of file <a class="el" href="driver__ws2812b_8c_source.html">driver_ws2812b.c</a>.</p>

</div>
</div>
<a id="ga2d68712e7e7d1b8f8329217f7a153bc6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2d68712e7e7d1b8f8329217f7a153bc6">&#9670;&nbsp;</a></span>ws2812b_info()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ws2812b_info </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__ws2812b__base__driver.html#ga4d2a587a69a1cc505cb403e5bd97e4da">ws2812b_info_t</a> *&#160;</td>
          <td class="paramname"><em>info</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>get chip's information </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[out]</td><td class="paramname">*info</td><td>pointer to a ws2812b info structure </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>2 handle is NULL </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ws2812b_8c_source.html#l00446">446</a> of file <a class="el" href="driver__ws2812b_8c_source.html">driver_ws2812b.c</a>.</p>

</div>
</div>
<a id="gae6fbb749585737a343245f99a12541ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae6fbb749585737a343245f99a12541ee">&#9670;&nbsp;</a></span>ws2812b_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ws2812b_init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *&#160;</td>
          <td class="paramname"><em>handle</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>initialize the chip </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 spi initialization failed</li>
<li>2 handle is NULL</li>
<li>3 linked functions is NULL </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ws2812b_8c_source.html#l00061">61</a> of file <a class="el" href="driver__ws2812b_8c_source.html">driver_ws2812b.c</a>.</p>

</div>
</div>
<a id="gaf9000e2cf8036d77c73d9131f8e8e495"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf9000e2cf8036d77c73d9131f8e8e495">&#9670;&nbsp;</a></span>ws2812b_set_reg()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ws2812b_set_reg </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *&#160;</td>
          <td class="paramname"><em>handle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>buf</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint16_t&#160;</td>
          <td class="paramname"><em>len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>set the chip register </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">*buf</td><td>pointer to a data buffer </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>data length </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 write failed</li>
<li>2 handle is NULL</li>
<li>3 handle is not initialized </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ws2812b_8c_source.html#l00424">424</a> of file <a class="el" href="driver__ws2812b_8c_source.html">driver_ws2812b.c</a>.</p>

</div>
</div>
<a id="ga60effc5b5f3a3326ffaa3a856629d264"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga60effc5b5f3a3326ffaa3a856629d264">&#9670;&nbsp;</a></span>ws2812b_write()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ws2812b_write </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *&#160;</td>
          <td class="paramname"><em>handle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>rgb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>temp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>temp_len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>write reset and color frame </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">*rgb</td><td>pointer to a rgb color buffer </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>rgb length </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">*temp</td><td>pointer to a temp buffer </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">temp_len</td><td>temp buffer length </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 write command failed</li>
<li>2 handle is NULL</li>
<li>3 handle is not initialized</li>
<li>4 rgb is null</li>
<li>5 temp is null</li>
<li>6 temp buffer is too small </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ws2812b_8c_source.html#l00181">181</a> of file <a class="el" href="driver__ws2812b_8c_source.html">driver_ws2812b.c</a>.</p>

</div>
</div>
<a id="gac6fd3f9b02dff6d25690de921ae3e021"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac6fd3f9b02dff6d25690de921ae3e021">&#9670;&nbsp;</a></span>ws2812b_write_only_color()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ws2812b_write_only_color </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *&#160;</td>
          <td class="paramname"><em>handle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t *&#160;</td>
          <td class="paramname"><em>rgb</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>temp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>temp_len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>write the color frame </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">*rgb</td><td>pointer to a rgb color buffer </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>rgb length </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">*temp</td><td>pointer to a temp buffer </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">temp_len</td><td>temp buffer length </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 write command failed</li>
<li>2 handle is NULL</li>
<li>3 handle is not initialized</li>
<li>4 rgb is null</li>
<li>5 temp is null</li>
<li>6 temp buffer is too small </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ws2812b_8c_source.html#l00327">327</a> of file <a class="el" href="driver__ws2812b_8c_source.html">driver_ws2812b.c</a>.</p>

</div>
</div>
<a id="ga9143c3d9bf67e15e3124f06a805cb9ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9143c3d9bf67e15e3124f06a805cb9ee">&#9670;&nbsp;</a></span>ws2812b_write_only_reset()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ws2812b_write_only_reset </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="group__ws2812b__base__driver.html#ga8e9cc95839b82bfd2baf02e566930593">ws2812b_handle_t</a> *&#160;</td>
          <td class="paramname"><em>handle</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>len</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>temp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>temp_len</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>write the reset frame </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramdir">[in]</td><td class="paramname">*handle</td><td>pointer to a ws2812b handle structure </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>rgb length </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">*temp</td><td>pointer to a temp buffer </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">temp_len</td><td>temp buffer length </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>status code<ul>
<li>0 success</li>
<li>1 write command failed</li>
<li>2 handle is NULL</li>
<li>3 handle is not initialized</li>
<li>4 temp is null</li>
<li>5 temp buffer is too small </li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>none </dd></dl>

<p class="definition">Definition at line <a class="el" href="driver__ws2812b_8c_source.html#l00266">266</a> of file <a class="el" href="driver__ws2812b_8c_source.html">driver_ws2812b.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1 </li>
  </ul>
</div>
</body>
</html>
